home *** CD-ROM | disk | FTP | other *** search
/ BMUG Revelations / BMUG Revelations.toast / Utilities / Text and Speech / CONText II 1.01 / CONText II Docs < prev    next >
Text File  |  1991-08-06  |  6KB  |  103 lines

  1. CONText II 1.0 Documentation
  2. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  3.  
  4. CONText II is a very powerful text editor.  It was designed to be used in conjunction with communication software and for small amounts text editing work.  CONText II was *not* designed to take the place of your word processor.  Its best for working on small text files.
  5.  
  6. CONText II is System 6 and 7 compatible and is 32 bit clean.  It will work on all Macs with system 6.0 and later.  It is compatible with programs like ATM and Thunder 7.
  7.  
  8. Since most of the features of CONText II are similar to all text editors and word processors, I’ll only describe the features unique to CONText II here.
  9.  
  10. Shareware
  11. ^^^^^^^^^
  12. CONText II is distributed using the Shareware system.  If you like CONText II and would like to get rid of that annoying dialog box every time you launch CONText II, send a check or money order for $15 (U.S.) to the address below.  For international orders, send an extra $2 for the added shipping costs.
  13.  
  14.      Michael Conrad
  15.      ATTN: CONText II
  16.      955 Escalon Ave. #505
  17.      Sunnyvale, CA  94086
  18.  
  19. For your bucks, you’ll receive the latest version of CONText II plus an application called “CONText II Converter” which will convert all copies of CONText II into the non-demo version.  You’ll also receive the source code for the standard macros that came with CONText II so you can use them as building blocks to build your own.
  20.  
  21. Opening Existing Files
  22. ^^^^^^^^^^^^^^^^^^^^^^
  23. CONText can read in any file of type ‘TEXT’.  When you select “Open” from the file menu, you will be presented with the standard open file dialog box.  Only text files will appear in the selection window.  You can double click on CONText II documents in the finder to open them as well.
  24.  
  25. CONText cannot display a file larger than 32K.  If you attempt to open an file larger than 32K, CONText will ask if you wish to open the file in separate segments of 30K each.  If you click “OK” CONText will open as many windows necessary to display the entire contents of the file.
  26.  
  27. Setting Preferences
  28. ^^^^^^^^^^^^^^^^^^^
  29. You set CONText’s preferences by selecting “Preferences...” from the file menu.  Here is where you tell CONText whether you want smart quotes on and set the documents creator.
  30.  
  31. The Finder uses the documents creator to determine which application to launch when it is double clicked, and to associate an icon with it.  You can, for example, save documents with the creator ‘MSWD’ (without the quotes) so when files are saved, they will appear like Microsoft™ Word documents.  Double clicking on them will launch Microsoft™ Word.  
  32.  
  33. By pressing “Creator Search” in the preferences dialog, you can find the creator of a word processor or editor without having to use programs such as ResEdit.  Just select the file or application who’s signature you want and its creator will be placed in the Document Creator edit field of the preferences dialog.
  34.  
  35. CONText’s preferences are saved in the system folder inside a folder called “Preferences.”  If this folder is not present, CONText II will create it.
  36.  
  37. Document Statistics
  38. ^^^^^^^^^^^^^^^^^^
  39. When this item is selected, a dialog will appear presenting you with the statistics concerning the current document.  Displayed will be the number of lines, characters, words and pages in the document.
  40.  
  41. Stripping Characters
  42. ^^^^^^^^^^^^^^^^^^^^
  43. Select “Strip Character...” from the edit menu to strip any ASCII character from your document.  This was designed for stripping control characters from text files.
  44.  
  45. Adjusting Carriage Returns
  46. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  47. With this option, you can place a carriage return every ‘n’ characters in the document.  This is useful when sending a text file to non-Mac computers or BBS’s.
  48.  
  49. Saving Default Text Characteristics
  50. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  51. Selecting “Save As Default” from the Text menu will save the current settings in the Text menu to the preferences file.  New documents will then start out using these settings. Saved are font, size and line spacing.
  52.  
  53. Macros
  54. ^^^^^^
  55. CONText II loads in the macros located in the file “CONText Macros.”  This file must reside in the same folder as CONText II for them to be loaded.  The macros perform certain operations on the text of a document.  The macros should be self explanatory by their name in the Macros menu.  
  56.  
  57. PROGRAMMERS:
  58.  
  59. You can build your own macros by using any compiler which can build code resources.  The main function in the code resource should read:
  60.  
  61.    In Pascal:
  62.  
  63.        FUNCTION main (theText:TEHandle):OSErr;
  64.  
  65.    In C:
  66.  
  67.        Pascal OSErr main (TEHandle theText)
  68.  
  69. CONText II passes a text edit handle to the document’s text in ‘theText’.  Your code resource should pass back any OS errors encountered during the macro operation.  Pass noErr if there are no errors.  CONText II will handle the reporting of errors for you.
  70.  
  71. Build the code resource to type ‘MCRO’.  Any unique ID will be ok since CONText II reads in the macros by their resource name.
  72.  
  73.  
  74. IMPORTANT:  Its YOUR responsibility to ensure that any memory you allocate gets allocated and disposed of properly.  If you cannot get memory as needed, pass memErr back to CONText.
  75.  
  76.     For Example:
  77.  
  78.       function main (theText:TEHandle):OSErr;
  79.         var
  80.           h:Handle;
  81.  
  82.       begin
  83.         h := NewHandle(120);
  84.         if h = nil then begin
  85.           main := memErr;
  86.           Exit(main);
  87.         end;
  88.        
  89.       ...
  90.  
  91.         DisposHandle(h);
  92.       end;
  93.  
  94. Once the macro is built, copy the code resource into the resource fork of the file “CONText Macros.”  The next time you launch CONText II, the macro name will appear in the Macro menu.
  95.  
  96. CONText II takes care of redrawing the text and also calls TECalText() upon the return of the macro.
  97.  
  98. Registered owners of CONText receive the source code to the standard macros that CONText II comes with.
  99.  
  100.  
  101.  
  102.  
  103.